Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OCI tags docs #52405

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add OCI tags docs #52405

wants to merge 2 commits into from

Conversation

atburke
Copy link
Contributor

@atburke atburke commented Feb 22, 2025

This change adds docs for the auto-importing of Oracle Cloud tags.

Depends on #52283.

@atburke atburke added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v17 labels Feb 22, 2025
@atburke atburke requested a review from rosstimothy February 22, 2025 00:08
@github-actions github-actions bot requested a review from mmcallister February 22, 2025 00:09
Copy link

github-actions bot commented Feb 22, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
atburke/oci-tags-docs b1d5f22 2 ✅SUCCEED atburke-oci-tags-docs 2025-02-24 19:51:34

Comment on lines 2 to 4
title: Oracle Cloud Tags as Teleport Agent Labels
description: How to set up Teleport agent labels based on Oracle Cloud labels
h1: Sync Oracle Cloud tags and Teleport agent labels
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title uses Teleport Agent the description and h1 use Teleport agent. Let's be consistent across all three.


When running on an Oracle Cloud (OCI) Compute instance, Teleport will
automatically detect and import the instance's freeform and defined tags
as Teleport labels for SSH nodes, applications, databases, and Kubernetes clusters.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we prefer node or ssh server in user facing docs? cc @ptgott

Suggested change
as Teleport labels for SSH nodes, applications, databases, and Kubernetes clusters.
as Teleport labels for SSH servers, applications, databases, and Kubernetes clusters.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we have a preference here! Looks like the docs are pretty evenly split:

 grep -REho "SSH (node|server)" docs/pages | sort | uniq -c
  93 SSH node
  80 SSH server

Comment on lines 7 to 15
When running on an Oracle Cloud (OCI) Compute instance, Teleport will
automatically detect and import the instance's freeform and defined tags
as Teleport labels for SSH nodes, applications, databases, and Kubernetes clusters.
Tags imported this way will have the `oracle/` prefix.

When the Teleport process starts, it fetches all tags from OCI instance
metadata and adds them as labels. The instance's image must support IMDSv2.
The process will update the tags every hour, so newly created or deleted tags
will be reflected in the labels.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we note in this section that no additional permissions are required to be granted to the OCI instance?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/branch/v17 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants